<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="safebrowsing_v5.html">Safe Browsing API</a> . <a href="safebrowsing_v5.hashList.html">hashList</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, sizeConstraints_maxDatabaseEntries=None, sizeConstraints_maxUpdateEntries=None, version=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, sizeConstraints_maxDatabaseEntries=None, sizeConstraints_maxUpdateEntries=None, version=None, x__xgafv=None)</code>
  <pre>Get the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET.

Args:
  name: string, Required. The name of this particular hash list. It may be a threat list, or it may be the Global Cache. (required)
  sizeConstraints_maxDatabaseEntries: integer, Sets the maximum number of entries that the client is willing to have in the local database for the list. (The server MAY cause the client to store less than this number of entries.) If omitted or zero, no database size limit is set.
  sizeConstraints_maxUpdateEntries: integer, The maximum size in number of entries. The update will not contain more entries than this value, but it is possible that the update will contain fewer entries than this value. This MUST be at least 1024. If omitted or zero, no update size limit is set.
  version: string, The version of the hash list that the client already has. If this is the first time the client is fetching the hash list, this field MUST be left empty. Otherwise, the client SHOULD supply the version previously received from the server. The client MUST NOT manipulate those bytes. **What&#x27;s new in V5**: in V4 of the API, this was called `states`; it is now renamed to `version` for clarity.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of hashes identified by its name.
  &quot;additionsEightBytes&quot;: { # Same as `RiceDeltaEncoded32Bit` except this encodes 64-bit numbers. # The 8-byte additions.
    &quot;encodedData&quot;: &quot;A String&quot;, # The encoded deltas that are encoded using the Golomb-Rice coder.
    &quot;entriesCount&quot;: 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
    &quot;firstValue&quot;: &quot;A String&quot;, # The first entry in the encoded data (hashes), or, if only a single hash prefix was encoded, that entry&#x27;s value. If the field is empty, the entry is zero.
    &quot;riceParameter&quot;: 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 35 and 62, inclusive.
  },
  &quot;additionsFourBytes&quot;: { # The Rice-Golomb encoded data. Used for either hashes or removal indices. It is guaranteed that every hash or index here has the same length, and this length is exactly 32 bits. Generally speaking, if we sort all the entries lexicographically, we will find that the higher order bits tend not to change as frequently as lower order bits. This means that if we also take the adjacent difference between entries, the higher order bits have a high probability of being zero. This exploits this high probability of zero by essentially choosing a certain number of bits; all bits more significant than this are likely to be zero so we use unary encoding. See the `rice_parameter` field. Historical note: the Rice-delta encoding was first used in V4 of this API. In V5, two significant improvements were made: firstly, the Rice-delta encoding is now available with hash prefixes longer than 4 bytes; secondly, the encoded data are now treated as big-endian so as to avoid a costly sorting step. # The 4-byte additions.
    &quot;encodedData&quot;: &quot;A String&quot;, # The encoded deltas that are encoded using the Golomb-Rice coder.
    &quot;entriesCount&quot;: 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
    &quot;firstValue&quot;: 42, # The first entry in the encoded data (hashes or indices), or, if only a single hash prefix or index was encoded, that entry&#x27;s value. If the field is empty, the entry is zero.
    &quot;riceParameter&quot;: 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 3 and 30, inclusive.
  },
  &quot;additionsSixteenBytes&quot;: { # Same as `RiceDeltaEncoded32Bit` except this encodes 128-bit numbers. # The 16-byte additions.
    &quot;encodedData&quot;: &quot;A String&quot;, # The encoded deltas that are encoded using the Golomb-Rice coder.
    &quot;entriesCount&quot;: 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
    &quot;firstValueHi&quot;: &quot;A String&quot;, # The upper 64 bits of the first entry in the encoded data (hashes). If the field is empty, the upper 64 bits are all zero.
    &quot;firstValueLo&quot;: &quot;A String&quot;, # The lower 64 bits of the first entry in the encoded data (hashes). If the field is empty, the lower 64 bits are all zero.
    &quot;riceParameter&quot;: 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 99 and 126, inclusive.
  },
  &quot;additionsThirtyTwoBytes&quot;: { # Same as `RiceDeltaEncoded32Bit` except this encodes 256-bit numbers. # The 32-byte additions.
    &quot;encodedData&quot;: &quot;A String&quot;, # The encoded deltas that are encoded using the Golomb-Rice coder.
    &quot;entriesCount&quot;: 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
    &quot;firstValueFirstPart&quot;: &quot;A String&quot;, # The first 64 bits of the first entry in the encoded data (hashes). If the field is empty, the first 64 bits are all zero.
    &quot;firstValueFourthPart&quot;: &quot;A String&quot;, # The last 64 bits of the first entry in the encoded data (hashes). If the field is empty, the last 64 bits are all zero.
    &quot;firstValueSecondPart&quot;: &quot;A String&quot;, # The 65 through 128th bits of the first entry in the encoded data (hashes). If the field is empty, the 65 through 128th bits are all zero.
    &quot;firstValueThirdPart&quot;: &quot;A String&quot;, # The 129 through 192th bits of the first entry in the encoded data (hashes). If the field is empty, the 129 through 192th bits are all zero.
    &quot;riceParameter&quot;: 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 227 and 254, inclusive.
  },
  &quot;compressedRemovals&quot;: { # The Rice-Golomb encoded data. Used for either hashes or removal indices. It is guaranteed that every hash or index here has the same length, and this length is exactly 32 bits. Generally speaking, if we sort all the entries lexicographically, we will find that the higher order bits tend not to change as frequently as lower order bits. This means that if we also take the adjacent difference between entries, the higher order bits have a high probability of being zero. This exploits this high probability of zero by essentially choosing a certain number of bits; all bits more significant than this are likely to be zero so we use unary encoding. See the `rice_parameter` field. Historical note: the Rice-delta encoding was first used in V4 of this API. In V5, two significant improvements were made: firstly, the Rice-delta encoding is now available with hash prefixes longer than 4 bytes; secondly, the encoded data are now treated as big-endian so as to avoid a costly sorting step. # The Rice-delta encoded version of removal indices. Since each hash list definitely has less than 2^32 entries, the indices are treated as 32-bit integers and encoded.
    &quot;encodedData&quot;: &quot;A String&quot;, # The encoded deltas that are encoded using the Golomb-Rice coder.
    &quot;entriesCount&quot;: 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
    &quot;firstValue&quot;: 42, # The first entry in the encoded data (hashes or indices), or, if only a single hash prefix or index was encoded, that entry&#x27;s value. If the field is empty, the entry is zero.
    &quot;riceParameter&quot;: 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 3 and 30, inclusive.
  },
  &quot;metadata&quot;: { # Metadata about a particular hash list. # Metadata about the hash list. This is not populated by the `GetHashList` method, but this is populated by the `ListHashLists` method.
    &quot;description&quot;: &quot;A String&quot;, # A human-readable description about this list. Written in English.
    &quot;hashLength&quot;: &quot;A String&quot;, # The supported hash length for this hash list. Each hash list will support exactly one length. If a different hash length is introduced for the same set of threat types or safe types, it will be introduced as a separate list with a distinct name and respective hash length set.
    &quot;likelySafeTypes&quot;: [ # Unordered list. If not empty, this specifies that the hash list represents a list of likely safe hashes, and this enumerates the ways they are considered likely safe. This field is mutually exclusive with the threat_types field.
      &quot;A String&quot;,
    ],
    &quot;threatTypes&quot;: [ # Unordered list. If not empty, this specifies that the hash list is a kind of threat list, and this enumerates the kind of threats associated with hashes or hash prefixes in this hash list. May be empty if the entry does not represent a threat, i.e. in the case that it represents a likely safe type.
      &quot;A String&quot;,
    ],
  },
  &quot;minimumWaitDuration&quot;: &quot;A String&quot;, # Clients should wait at least this long to get the hash list again. If omitted or zero, clients SHOULD fetch immediately because it indicates that the server has an additional update to be sent to the client, but could not due to the client-specified constraints.
  &quot;name&quot;: &quot;A String&quot;, # The name of the hash list. Note that the Global Cache is also just a hash list and can be referred to here.
  &quot;partialUpdate&quot;: True or False, # When true, this is a partial diff containing additions and removals based on what the client already has. When false, this is the complete hash list. When false, the client MUST delete any locally stored version for this hash list. This means that either the version possessed by the client is seriously out-of-date or the client data is believed to be corrupt. The `compressed_removals` field will be empty. When true, the client MUST apply an incremental update by applying removals and then additions.
  &quot;sha256Checksum&quot;: &quot;A String&quot;, # The sorted list of all hashes, hashed again with SHA256. This is the checksum for the sorted list of all hashes present in the database after applying the provided update. In the case that no updates were provided, the server will omit this field to indicate that the client should use the existing checksum.
  &quot;version&quot;: &quot;A String&quot;, # The version of the hash list. The client MUST NOT manipulate those bytes.
}</pre>
</div>

</body></html>